/**
Copyright (c) 2008 New Gonzo <john@newgonzo.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
**/


package com.newgonzo.commons.parsing
{
	
	public class Token
	{
		public static const EOF:int = -1;
		
		private var tokenType:int;
		private var tokenSource:String;
		private var tokenValue:String;
		private var tokenSourceIndex:int;
		private var tokenSourceColumn:int;
		private var tokenSourceRow:int;
		
		public function Token(type:int, source:String = "", value:String = "", sourceIndex:int = -1, sourceColumn:int = 1, sourceRow:int = 1)
		{
			tokenType = type;
			tokenSource = source;
			tokenValue = value;
			tokenSourceIndex = sourceIndex;
			tokenSourceColumn = sourceColumn;
			tokenSourceRow = sourceRow;
		
		}
		
		public function get type():int
		{
			return tokenType;
		}
		
		public function get value():String
		{
			return tokenValue;
		}
		
		public function get source():String
		{
			return tokenSource;
		}
		
		public function get sourceIndex():int
		{
			return tokenSourceIndex;
		}
		
		public function get column():int
		{
			return tokenSourceColumn;
		}
		
		public function get row():int
		{
			return tokenSourceRow;
		}
		
		
		/**
		* Override in subclasses to provide meaningful names for token types
		*/
		public function getTypeName(type:int):String
		{
			switch(type)
			{
				case EOF: return "EOF";
				default: return tokenType.toString();
			}
		}
		
		public function toString():String
		{
			return "[Token(type=" + getTypeName(tokenType) + " source=" + tokenSource + " value='" + tokenValue + "' index=" + tokenSourceIndex + " column=" + tokenSourceColumn + " row=" + tokenSourceRow + ")]";
		}
	}
}